/*
 *    Copyright 2009-2012 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.type;

import org.apache.ibatis.annotations.HasRead;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * @author Clinton Begin
 */

/**
 * 类型处理器
 * 当MyBatis为PreparedStatement  https://www.cnblogs.com/noteless/p/10307273.html#1
 * 设置参数时或者从ResultSet中获取数据时，
 * <p>
 * 会根据Java类型使用TypeHandler 去获取相应的值。
 * <p>
 * 官网中也列出了每一个TypeHandler用来处理对应的ＪＤＢＣ类型和ＪＡＶＡ类型 （ORM本质  sql的类 与 java类 对应。）。
 * <p>
 * <p>
 * 这个接口有三个方法，一个set，用来给PreparedStatement对象对应的列设置参数；
 * <p>
 * 两个get,从ResultSet和CallableStatement获取对应列的值,不
 * <p>
 * 同之处是一个是取第几个位置的值，一个是取具体列名所对应的值。
 * <p>
 * set用来将Java对象中的数据类型转换为JDBC中对应的数据类型，
 * <p>
 * get用来将JDBC中对应的数据类型转换为Java对象中的数据类型转换。
 */
@HasRead
public interface TypeHandler<T> {

    //为PreparedStatement对象对应的列设置参数
    void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;

    //取得结果,供普通select用
    T getResult(ResultSet rs, String columnName) throws SQLException;

    //取得结果,供普通select用
    T getResult(ResultSet rs, int columnIndex) throws SQLException;

    //取得结果,供存储过程SP用
    T getResult(CallableStatement cs, int columnIndex) throws SQLException;

}
